<html>
<head>
<title>Документация QStarDict</title>
<link rel="stylesheet" type="text/css" href="styles/style.css">
</head>
<body>

<div id="wrap">
<h1>Документация QStarDict</h1>

<p>
QStarDict &mdash; это словарное приложение. Оно позволяет пользователю
устанавливать словари Kiwix и StarDict и искать слова в этих словарях.
</p>

<p>Эта инструкция должна помочь Вам в использовании QStarDict.</p>

<h2>Содержание</h2>
<ul>
<li><a href="#запуск-qstardict">Запуск QStarDict</a></li>
<li><a href="#работа-в-фоне">Работа в фоне</a></li>
<li><a href="#запуск-с-системой">Запуск с системой</a></li>
<li><a href="#установка-словарей-kiwix">Установка словарей Kiwix</a></li>
<li><a href="#установка-словарей-stardict">Установка словарей StarDict</a></li>
<li><a href="#поиск-слов">Поиск слов</a></li>
<li><a href="#всплывающее-окно">Всплывающее окно</a></li>
</ul>

<a href="#запуск-qstardict" name="запуск-qstardict"><h2>Starting QStarDict</h2></a>
<p>QStarDict можно запустить либо через меню среды среды рабочего стола в разделе
«Образование», либо с использованием командной строки путем набора команды

<p><code>
qstardict
</code></p>

<a href="#работа-в-фоне" name="работа-в-фоне"><h2>Работа в фоне</h2></a>

<p>Когда QStarDict запущен, он может быть либо в нормальном режиме, когда главное
окно показано, как здесь:

<img src="images/main-window-intro.png" width="100%">

или он может быть запущен в фоновом режиме.
</p>

<p>
Когда QStarDict запущен в фоновом режиме, он может быть показать в области
уведомлений:
</p>

<p align="center"><img src="images/notification-area.png"></p>

<p>
Предназначение фонового режима &mdash; сделать возможным для QStarDict сканирование
cвыделения в других приложениях и показ всплывающего окна со словарными статьями.
Смотрите раздел о <a href="#всплывающее-окно">всплывающем окне</a> для деталей.
</p>

<p>
Для того, чтобы сделать возможным для QStarDict быть запущенным в фоне,
соответствующая настройка должна быть включена:

<img src="images/settings-run-in-background.png" width="100%">

По умолчанию она включена.
</p>

<p>
QStarDict запоминает, был ли он в нормальном или фоновом режиме, при выходе,
и при последующем запуске восстанавливает состояние нахождения в фоновом режиме.
</p>

<p>
Если Вы хотите, чтобы QStarDict запускался в фоновом режиме, используйте
опцию командной строки <code>--background</code>, запуская QStarDict как
</p><p>
<code>
qstardict --background
</code>
</p>

<a href="#запуск-с-системой" name="запуск-с-системой"><h2>Запуск с системой</h2></a>
<p>
Возможно настроить запуск QStarDict вместе с системой в распространенных средах
рабочего стола. Для того, чтобы включить запуск QStarDict с системой, используйте
соответствующую настройку:
</p>

<p align="center"><img src="images/settings-start-with-system.png" width="100%"></p>

<p>
По умолчанию запуск с системой отключен.
</p>

<a href="#установка-словарей-kiwix" name="установка-словарей-kiwix">
<h2>Установка словарей Kiwix</h2></a>

<p>
<a href="https://kiwix.org/en/">Kiwix</a> &mdash; это проект, целью которого
является создание оффлайн-версий веб-сайтов. Наиболее выдающимся среди этих
веб-сайтов для использования с QStarDict является <a href="https://www.wiktionary.org/">Викисловарь</a>.
</p>

<p>
Для того, чтобы загрузить оффлайн-версии Викисловаря для языков, которые Вам
требуются, посетите
<a href="https://download.kiwix.org/zim/wiktionary/">Страницу загрузки ZIM-файлов</a>
и выберите версию "nopic" Викисловаря для языка, который Вам требуется.
</p>

<p>Обратите внимание, что язык, указанный в имени файла является целевым языком,
а не исходным языком. Каждый язык содержит статьи для слов на всех исходных
языках на целевом языке. К примеру, если Вы хотите смотреть слова на английском,
переведенные на русский, Вам нужно выбрать файл с языковым кодом «ru_all».
</p>

<p>Примеры названий файлов:</p>
<ul>
<li>«wiktionary_ru_all_nopic_2023-09.zim» &mdash; словарь на русском для всех языков;</li>
<li>«wiktionary_en_all_nopic_2023-07.zim» &mdash; словарь на английском для всех языков.</li>
</ul>

<p>
Предположим, что Вы загрузили файл «wiktionary_en_all_nopic_2023-07.zim» в
директорию «~/Загрузки».
</p>

<p>
Он может быть установлен из вкладки «Словари» диалога настроек, который может
быть открыт с использованием меню «Настройки»&nbsp;→&nbsp;«Конфигурация» в главном
окне:

<img src="images/settings-dictionaries-add.png" width="100%">
</p>

<p>Для того, чтобы установить словарь, нажмите кнопку «Добавить словарь», которая
отмечена на скриншоте.
</p>

<p>
Выполнение этого приведет к открытию файлового диалога:
</p>

<img src="images/file-dialog-kiwix.png" width="100%">

<p>
В файловом диалоге выберите фильтр «ZIM файлы Kiwix» (отмеченный на скриншоте)
и затем выберите ZIM файл, который Вы хотите добавить.
</p>

<p>Когда файл выбран, появится диалог добавления словаря:</p>

<img src="images/add-dialog-kiwix.png">

<p>
Он предложит Вам переместить словарь в директорию QStarDict.
</p>

<p>
Также возможно не перемещать словарный файл, а создать символическую ссылку на
словарный файл. Для того, чтобы сделать это, выберите пункт меню "Symlink" в
комбинированном списке в диалоге добавления.
</p>

<p>
После импорта словарю он появится наверху в списке словарей в диалоге настроек:
</p>

<img src="images/settings-dictionaries-dict-kiwix.png" width="100%">

<p>
После нажатия кнопки OK добавленные словари будут включены и станет возможным
<a href="#поиск-слов">искать слова</a> из него.
</p>

<a href="#установка-словарей-stardict" name="установка-словарей-stardict"><h2>Установка словарей StarDict</h2></a>

<p>
QStarDict поддерживает словари в формате StarDict 2.x и StarDict 3.x.
</p>

<p>
Словарь StarDict состоит из трех файлов:
</p>

<ul>
<li>«.ifo» &mdash; файл, содержащий метаданные о словаре;
<li>«.idx» &mdash; индексный файл словаря;
<li>«.dict.dz» &mdash; файл, содержащий словарные статьи.
</ul>

<p>
Словарь StarDict может быть установлен в QStarDict путем открытия вкладки «Словари»
в диалоге настроек, который может быть открыт с использованием меню
«Настройки»&nbsp;→&nbsp;«Конфигурация» в главном окне:

<img src="images/settings-dictionaries-add.png" width="100%">

Для того, чтобы установить словарный файл в QStarDict, нажмите кнопку
«Добавить словарь», которая отмечена на скриншоте.
</p>

<p>
Это приведет к открытию файлового диалога:
</p>

<img src="images/file-dialog-stardict.png" width="100%">

<p>
В файловом диалоге выберите фильтр «IFO файлы StarDict» (отмеченный на скриншоте)
и затем выберите ".ifo" файл, который Вы хотите добавить.
</p>

<p>
Обратите внимание, что «.idx» и «.dict.dz» файлы должны быть в той же директории,
что и «.ifo» файл для того, чтобы словарь мог быть успешно импортирован.
</p>

<p>
После импортирования словаря он появится наверху списка словарей в диалоге настроек:
</p>

<img src="images/settings-dictionaries-dict-stardict.png" width="100%">

<p>
После нажатия OK добавленные словари будут включены и станет возможным 
<a href="#поиск-слов">искать слова</a> в нем.
</p>

<a href="#поиск-слов" name="поиск-слов"><h2>Поиск слов</h2></a>

<p>
Является возможным искать слова в главном окне QStarDict. Слова, которые требуется
найти, могут быть введены в текстовое поле ввода. По умолчанию слова ищутся
по мере того, как они введены, но это поведение может быть отключено в разделе
«Общие настройки» диалога конфигурации.
</p>

<a href="#всплывающее-окно" name="всплывающее-окно"><h2>Всплывающее окно</h2></a>

<p>
Всплывающее окно &mdash; это окно, которое может быть показано рядом со словами,
выделенными мышью. Его поведение может быть настроено во вкладке «Всплывающее окно»
диалога конфигурации.
</p>

</div>
</body>
</html>
